Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update spelling typos #223

Merged
merged 3 commits into from
Jan 1, 2025
Merged

Update spelling typos #223

merged 3 commits into from
Jan 1, 2025

Conversation

billdenney
Copy link
Contributor

No description provided.

eddelbuettel
eddelbuettel reviewed Dec 31, 2024
View reviewed changes
src/zconf.h Outdated
@@ -1,5 +1,5 @@
/* zconf.h -- configuration of the zlib compression library
* Copyright (C) 1995-2004 Jean-loup Gailly.
* Copyright (C) 1995-2004 Jean-Loup Gailly.
Copy link
Owner

@eddelbuettel eddelbuettel Dec 31, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just today I came across a reference that this routine is likely one of the three most-widely-used pieces of code in trillions of instances across the globe.

In each and every copyright header Mr Gailly writes his name as 'Jean-loup'. I think we should let him.

PS I have seen this copyright line for probably close to the 30 years it existed and I always had the same git instinct about uppercase. But ... not the polite thing to do to tell how to spell his own name.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know that he spelled his name that way. The only reason I made the change is because it was inconsistently capitalized in other places. I agree that anyone should get to spell their own name the way that they like. I've reverted throughout where I made it upper-case, and I made it lower case where it was upper case in a few places.

eddelbuettel
eddelbuettel reviewed Dec 31, 2024
View reviewed changes
src/zutil.h Outdated
@@ -1,5 +1,5 @@
/* zutil.h -- internal interface and configuration of the compression library
* Copyright (C) 1995-2003 Jean-loup Gailly.
* Copyright (C) 1995-2003 Jean-Loup Gailly.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above.

eddelbuettel
eddelbuettel reviewed Dec 31, 2024
View reviewed changes
src/zlib.h Outdated
@@ -1,7 +1,7 @@
/* zlib.h -- interface of the 'zlib' general purpose compression library
version 1.2.2, October 3rd, 2004

Copyright (C) 1995-2004 Jean-loup Gailly and Mark Adler
Copyright (C) 1995-2004 Jean-Loup Gailly and Mark Adler
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above

eddelbuettel
eddelbuettel reviewed Dec 31, 2024
View reviewed changes
src/zlib.h Outdated
@@ -19,7 +19,7 @@
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.

Jean-loup Gailly Mark Adler
Jean-Loup Gailly Mark Adler
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above

eddelbuettel
eddelbuettel reviewed Dec 31, 2024
View reviewed changes
man/digest.Rd Outdated
@@ -84,7 +84,7 @@ digest(object, algo=c("md5", "sha1", "crc32", "sha256", "sha512",

For md5, sha-1 and sha-256, this R implementation relies on standalone
implementations in C by Christophe Devine. For crc32, code from the
zlib library by Jean-loup Gailly and Mark Adler is used.
zlib library by Jean-Loup Gailly and Mark Adler is used.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See elsewhere.

@eddelbuettel
Copy link
Owner

Hi @billdenney and Happy New Year! I really appreciate helpful 'eagle eyes' spotting typos would I would like to ask to drastically reduce the scope of the PR. Everything below docs/ is auto generated, and I would prefer it continued to be generated by the 'frozen in a docker container' version of material for mkdocs I have here. So can we regroup, fix what is in

  • DESCRIPTION
  • README.md
  • man/ (but see digest.Rd comment)
  • vignettes

and leaving alone

  • docs/ (generated)
  • inst/ (not asked for)
  • src/ (see comments)

Thanks so much.

eddelbuettel
eddelbuettel requested changes Dec 31, 2024
View reviewed changes
Copy link
Owner

@eddelbuettel eddelbuettel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This won't work as is, please see comments.

Appreciate the PR but this went a little too far, too fast, without enough checking.

@billdenney
Copy link
Contributor Author

billdenney commented Dec 31, 2024 •
edited
Loading

I have reverted and revised. Now "loup" is always lower case (there were a few places where it was upper-case).

Oh, and FYI, the inst/WORDLIST file enables the use of spelling::update_wordlist() not to warn about words that are known to be spelled correctly. Fair that it's not desired; letting you know why it's there and could be helpful.

@eddelbuettel
Copy link
Owner

I have reverted and revised. Now "loup" is always lower case (there were a few places where it was upper-case).

My preference would be to leave the as-is unless you have a strong reason to fix. I.e. when you see me misspell 'numerically' in numerous ways, fix. How someone else wrote their copyright header is not something I as maintainer support altering---unless they ask me. So I think we should revert all such changes in the spelling of his name to what it was. Would that be acceptable?

I once added a spelling list to one package, it mostly got stale. I have no intention of adding one. If you happen to use other tools by all means do so -- but make use of both .gitignore and .Rbuildignore as needed, preferably just locally. Maybe just maybe overzealous use of such tools something to do with fixing in files in that are autogenerated 😉

eddelbuettel
eddelbuettel reviewed Dec 31, 2024
View reviewed changes
man/digest.Rd
@@ -155,7 +155,7 @@ digest(object, algo=c("md5", "sha1", "crc32", "sha256", "sha512",
Antoine Lucas for the integration of crc32; Jarek Tuszynski for the
file-based operations; Henrik Bengtsson and Simon Urbanek for improved
serialization patches; Christophe Devine for the hash function
implementations for sha-1, sha-256 and md5; Jean-Loup Gailly and Mark Adler
implementations for sha-1, sha-256 and md5; Jean-loup Gailly and Mark Adler
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good fix, correcting my own inadvertent mis-caseing!

@eddelbuettel
Copy link
Owner

The now remaining fixes are great! Thanks a bunch for these.

eddelbuettel
eddelbuettel approved these changes Jan 1, 2025
View reviewed changes
Copy link
Owner

@eddelbuettel eddelbuettel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks very much!

@eddelbuettel eddelbuettel merged commit 0000866 into eddelbuettel:master Jan 1, 2025
4 checks passed
@billdenney billdenney deleted the spelling branch January 1, 2025 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eddelbuettel eddelbuettel eddelbuettel approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@billdenney @eddelbuettel